ri是Ruby用來查詢API文件的工具,可以查詢Class, Modules與Method,只要輸入Class,Modules與Method的名稱,ri就可以顯示其用法.
雖然平時要查詢Ruby 的各類API可以直接上網查詢,但是如果剛好碰到一個沒網路的環境,或是純粹只想查詢本機安裝的文件,這個時候ri就可以幫助開發者查詢有關Ruby API的文件.
如果要顯示目前所有的class,那麼我們可以輸入以下的指令
ri --classes
或
ri -c
這樣的指令除了會顯示已知的Classes外,也很貼心的以分頁的方式如果顯示,但如果說不要採取分頁方式顯示,想要一次就顯示在螢幕上,則輸入
ri -c -T
這樣就不會以分頁方式顯示
註:但在使用ri前必須特別注意的是,像在安裝gem時就不可以輸入--no-ri與--no-rdoc的參數,否則就算輸入ri,也無法查詢到任何文件的.